home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / AppleSearch / Macintosh / ASClient Update SDK / UpdateSDK / Headers / ASUpdateArticleUtilities.h next >
Encoding:
C/C++ Source or Header  |  1995-01-19  |  3.4 KB  |  82 lines  |  [TEXT/MPS ]
  1.  
  2. /*===============================================================================================================
  3.  
  4.         ASUpdateArticleUtilities.h
  5.     
  6.         Copyright Apple Computer, Inc. 1992-1993
  7.         All rights reserved
  8.  
  9. ===============================================================================================================*/
  10.  
  11. #ifndef __ASUPDATEARTICLEUTILITIES__
  12. #define __ASUPDATEARTICLEUTILITIES__
  13.  
  14. //_______________________________________________________________________________________________________________
  15. //____________________________________________________ INCLUDES _________________________________________________
  16. //_______________________________________________________________________________________________________________
  17.  
  18. #ifndef __ASUPDATETYPES__
  19. #include "ASUpdateTypes.h"
  20. #endif                                                
  21.  
  22. #ifndef __ASUPDATECONSTANTS__
  23. #include "ASUpdateConstants.h"
  24. #endif                                                
  25.  
  26. #ifndef __ASUPDATEDCUTILITIES__
  27. #include "ASUpdateDCUtilities.h"
  28. #endif                                                
  29.  
  30. //_______________________________________________________________________________________________________________
  31. //_____________________________________________________ STRUCTS _________________________________________________
  32. //_______________________________________________________________________________________________________________
  33.  
  34. struct ASUArticleHeader {
  35.     ASUDataSize        articleHeaderSize;
  36.     ASUDataSize        articleDataSize;
  37.     ASUArticleType    articleType;
  38.     ASUArticleDate    articleDateTime;
  39.     long            userBytes;
  40.     char*            articleTitle;
  41.     char*            articleSource;
  42. };
  43. typedef struct ASUArticleHeader ASUArticleHeader, *ASUArticleHeaderPtr;
  44.  
  45. //_______________________________________________________________________________________________________________
  46. //_______________________________________________ FUNCTION PROTOTYPES ___________________________________________
  47. //_______________________________________________________________________________________________________________
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51.  
  52. OSErr    ASUAddArticle( short refnum, ASUArticleHeader* info, ASUDataSize count, Ptr buffer, ASUDCPtr *dc );
  53. OSErr    ASUDeleteArticle( short refnum, ASUDCPtr dc );
  54.  
  55. OSErr    ASUReadArticleHeader( short refnum, ASUDCPtr dc, ASUArticleHeader* info );
  56. OSErr    ASUWriteArticleHeader( short refnum, ASUDCPtr dc, ASUArticleHeader* info );
  57.  
  58. OSErr    ASUReadArticleData( short refnum, ASUDCPtr dc, Ptr buffer );
  59. OSErr    ASUReadPartialArticleData( short refnum, ASUDCPtr dc, ASUOffset start, ASUDataSize* count, Ptr buffer );
  60. OSErr    ASUWriteArticleData( short refnum, ASUDCPtr dc, ASUOffset start, ASUDataSize count, Ptr buffer );
  61.  
  62. //_______________________________________________________________________________________________________________
  63.  
  64. OSErr    ASUCountArticles( short refnum, ASUCount* count );
  65. OSErr    ASUFindArticle( short refnum, ASUDCPtr start, ASUDCPtr *dc );
  66.  
  67. OSErr    ASUGetArticleSize( short refnum, ASUDCPtr dc, ASUDataSize* size );
  68. OSErr    ASUGetArticleType( short refnum, ASUDCPtr dc, ASUArticleType* type );
  69. OSErr    ASUGetArticleUserBytes( short refnum, ASUDCPtr dc, long* userBytes );
  70.  
  71. //_______________________________________________________________________________________________________________
  72. // Misc. calls
  73.  
  74. OSErr    ASUDisposeArticleHeader( ASUArticleHeader* info );
  75.  
  76. //_______________________________________________________________________________________________________________
  77.  
  78. #ifdef __cplusplus
  79. }
  80. #endif
  81.  
  82. #endif                                                            // __ASUPDATEARTICLEUTILITIES__